package cn.iocoder.boot.flowabledemo.demos.web;

import lombok.Getter;
import lombok.Setter;

/**
 * 基础响应类，用于封装 API 响应结果。
 * <p>
 * 该类提供了一种统一的格式来返回操作结果，包括状态码、消息和数据。
 * 通过使用泛型，可以灵活地返回不同类型的数据。
 *
 * @param <T> 响应数据的类型
 */
@Getter
@Setter
public class BaseResponse<T> {
    /**
     * 状态码，表示操作是否成功。
     * - 0：表示操作成功
     * - 非 0：表示操作失败，具体含义由业务定义
     */
    private Integer code;

    /**
     * 消息，提供操作结果的简短描述。
     */
    private String message;

    /**
     * 数据，携带操作结果的具体内容。
     */
    private T data;

    /**
     * 构造函数，用于创建 {@code BaseResponse} 对象。
     *
     * @param code    状态码
     * @param message 消息
     * @param data    数据
     */
    public BaseResponse(Integer code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    /**
     * 静态方法，用于创建成功的响应。
     * <p>
     * 该方法会设置状态码为 0，并提供默认的成功消息 "Success"。
     *
     * @param data 响应数据
     * @return 成功的 {@code BaseResponse} 对象
     */
    public static <T> BaseResponse<T> success(T data) {
        return new BaseResponse<>(0, "Success", data);
    }

    /**
     * 静态方法，用于创建失败的响应。
     * <p>
     * 该方法会设置指定的状态码和消息，并将数据设置为 {@code null}。
     *
     * @param code    状态码
     * @param message 消息
     * @return 失败的 {@code BaseResponse} 对象
     */
    public static <T> BaseResponse<T> failure(Integer code, String message) {
        return new BaseResponse<>(code, message, null);
    }
}